/*
 * Copyright 2021 4Paradigm
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com._4paradigm.sql.jmh;

import java.sql.Connection;
import java.sql.SQLException;

public interface DatabaseSetup {
    /**
     * Init connection to database & Setup data
     *  create new database & tables, generate records
     * @throws SQLException
     */
    void setup() throws SQLException;

    /**
     * Cleanup
     *  drop database & table, close database connection
     * @throws SQLException
     */
    void teardown() throws SQLException;

    /**
     * get the database name of the connection, which may required
     *   in the jdbc url. e.g 'jdbc:mariadb:localhost:3306/db_name'
     * @return generated database name
     */
    default String getDb() {
        return "db_" + this.getClass().getSimpleName();
    }

    Connection getConnection();
}
